home *** CD-ROM | disk | FTP | other *** search
/ c't freeware shareware 2001 January / CT_SW0101.ISO / mac / software / dateiman / dateimgr / cdfindx.sit / cdfinder.img / CDFinder 3.1.1 Mac OS X / Extras / CDFinder & AppleScript < prev    next >
Text File  |  2000-12-18  |  11KB  |  175 lines

  1. This document explains some of the details of the current AppleScript implementation
  2. Release: CDFinder 3.0
  3.  
  4. Future versions will include even more support. If you have suggestions, please let me know!
  5.  
  6. ===========================================================
  7.  
  8. The new version 2.8.1 of CDFinder has again an extended AppleScript ability.
  9. It is now possible to access the basic catalog and catalog folder info in a real object structured manner. Here is the new part of the dictionary. In addition, the preferences section contains two new properties that contain the number of catalogs and catalog folders. I know, I should have included a count command, but the implementation of it was much more complicated than I thought and I will add it in a later version.
  10.  
  11. As you can see, you can change the name, the comment, the label, and the selection of a catalog and also a catalog folder. It is also possible to open or close a catalog folder by changing the is open property.
  12.  
  13. The actual contents of a catalog will be revealed in a later version!
  14.  
  15. A new event will reveal a catalog or catalog folder in the main window. That event will of course later be used for other classes, too. Starting with 2.8.1, this now includes Found Items.
  16.  
  17. show: Bring an object into view
  18.     show  reference  -- The object to be made visible
  19.  
  20. ===========================================================
  21.  
  22. Class catalog: one catalog file
  23. Plural form:
  24.     catalogs
  25. Properties:
  26.     ID  integer  [r/o]  -- unique ID of this catalog. Only valid during one run of CDFinder!
  27.     name  text  -- the name of the catalog as the user sees it
  28.     volume name  text  [r/o]  -- name of the original volume
  29.     file name  text  [r/o]  -- name of the actual catalog file, usually the same a the name of the catalog
  30.     comment  text  -- the comment that the user has entered
  31.     label  small integer  -- the label of the catalog. 0 is none
  32.     filenumber  integer  [r/o]  -- number of files in the catalog
  33.     foldernumber  integer  [r/o]  -- number of folders in the catalog
  34.     size  integer  [r/o]  -- the size of the f in KB
  35.     free space  integer  [r/o]  -- the free space on that volume in KB
  36.     formatted  date  [r/o]  -- the date and time when the volume was formatted (created)
  37.     modified  date  [r/o]  -- the date and time when the volume was last modified
  38.     catalog created  date  [r/o]  -- the creation date and time of this catalog
  39.     catalog folder ID  integer  [r/o]  -- The ID of the catalog folder that contains this catalog. Is zero if the catalog lies in the top level.
  40.     selected  boolean  -- is the catalog selected in the main window?
  41.     load data at startup  boolean  -- if true, CDFinder tries to load the data of this catalog soon after startup. Use this to speed up your searches, but use it wisely!
  42.  
  43. Class catalog folder: a folder that contains catalog files
  44. Plural form:
  45.     catalog folders
  46. Properties:
  47.     name  text  -- the name of the catalog folder
  48.     comment  text  -- the user comment
  49.     ID  integer  [r/o]  -- the ID of this catalog folder. Unique duringe one run of CDFinder.
  50.     label  small integer  -- The label of this catalog folder
  51.     created  date  [r/o]  -- The date and time of the creation of this catalog folder.
  52.     modified  date  [r/o]  -- The date and time of the last modification of this catalog folder
  53.     is open  boolean  -- Is this catalog folder open?
  54.     selected  boolean  -- is the catalog folder selected in the main window?
  55.  
  56.  
  57. Class found item: an item in the Found Items window
  58. Properties:
  59.     ID  integer  [r/o]  -- the unique ID of this item. Only valid until a new Find operation is invoked!
  60.     name  text  [r/o]  -- the name of this item
  61.     folder  boolean  [r/o]  -- if true, the item is a folder, otherwise a file
  62.     comment  text  [r/o]  -- the comment of the found item
  63.     version  text  [r/o]  -- the version info of the found item
  64.     label  small integer  -- the label of this item
  65.     created  date  [r/o]  -- The date and time of the creation of this item
  66.     modified  date  [r/o]  -- The date and time of the last modification of this item
  67.     size  integer  [r/o]  -- the size of the file in KB, but of course only if it is a file!
  68.     file type  type class  [r/o]  -- the four character c of the item, if it is a file
  69.     creator type  type class  [r/o]  -- the four character creator code of the item, if it is a file
  70.     catalogID  integer  [r/o]  -- the ID of the catalog that contains this item.
  71.     selected  boolean  -- is the item selected in the Found Items window?
  72.     full path  text  [r/o]  -- the full path of the found item
  73.  
  74.  
  75.  
  76. ===========================================================
  77.  
  78. Class application: CDFinder's preferences
  79. Elements:
  80.     catalog by numeric index, by ID, by name
  81.     catalog folder by numeric index, by ID, by name
  82.     found item by numeric index, by ID, by name
  83. Properties:
  84.     name  international text  [r/o]  -- the application’s name
  85.     frontmost  boolean  [r/o]  -- Is CDFinder the frontmost process?
  86.     version  international text  [r/o]  -- the version of CDFinder
  87.     global catalog folder  alias  -- an alias to the main catalog folder
  88.     language  Deutsch/English/Francais/Italian/Swedish/Chinese/Japanese  -- the language of the user interface
  89.     play sound  boolean  -- should CDFinder play a sound after long operations?
  90.     label1  international text  -- the name of label 1
  91.     label2  international text  -- the name of label 2
  92.     label3  international text  -- the name of label 3
  93.     label4  international text  -- the name of label 4
  94.     label5  international text  -- the name of label 5
  95.     label6  international text  -- the name of label 6
  96.     label7  international text  -- the name of label 7
  97.     main display version  boolean  -- display a column with the version of the catalog in the main window
  98.     main display size  boolean  -- display a column with the size of a volume in the main window
  99.     main display unused  boolean  -- display a column with the unused space of a volume in the main window
  100.     main display label  boolean  -- display a column with the label of a volume in the main window
  101.     main display modification date  boolean  -- display a column with the modification date of a volume in the main window
  102.     main display comment  boolean  -- display a column with the comment of a volume in the main window
  103.     catalog display size  boolean  -- display a column with the size of an item in a catalog window
  104.     catalog display filetype  boolean  -- display a column with the filetype of an item in a catalog window
  105.     catalog display creator  boolean  -- display a column with the creator code of an item in a catalog window
  106.     catalog display modification date  boolean  -- display a column with the modification date of an item in a catalog window
  107.     catalog display creation date  boolean  -- display a column with the creation date of an item in a catalog window
  108.     catalog display label  boolean  -- display a column with the label of an item in a catalog window
  109.     catalog display icons  boolean  -- display the Finder icon of any item in a catalog window (slower!)
  110.     catalog display version info  boolean  -- display a column with the version info of the file in a catalog window
  111.     catalog display comment  boolean  -- display a column with the comment of the item in a catalog window
  112.     catalog display catalog name  boolean  -- display a column with the catalog name of an item in the found items window
  113.     ignore invisibles  boolean  -- creating a new catalog: ignore invisible files
  114.     ignore icons  boolean  -- creating a new catalog: ignore icons files
  115.     ignore alias files  boolean  -- creating a new catalog: ignore all alias files
  116.     open StuffIt  boolean  -- creating a new catalog: open StuffIt files
  117.     open CompactPro  boolean  -- creating a new catalog: open Compact Pro files
  118.     open Installer  boolean  -- creating a new catalog: open Installer archive files (TOME)
  119.     open ZIP  boolean  -- creating a new catalog: open ZIP archive files
  120.     read version info  boolean  -- creating a new catalog: read the version info of the file, if any
  121.     read comment  boolean  -- creating a new catalog: read the Finder comments to the item, if any
  122.     always confirm  boolean  -- when creating or updating a catalog, always confirm the settings
  123.     catalog number  integer  [r/o]  -- the number of catalog files 
  124.     catalog folder number  integer  [r/o]  -- the number of catalog folders known to the application
  125.     found items number  integer  [r/o]  -- the number of items currently found
  126.  
  127.  
  128. ===========================================================
  129.  
  130. find in: start a new Find operation
  131.     find in  all catalogs/selected catalogs/catalogs without label/catalogs with label 1/catalogs with label 2/catalogs with label 3/catalogs with label 4/catalogs with label 5/catalogs with label 6/catalogs with label 7/found items  -- the selection of catalog files to be searched
  132.         first kind  theName/theComment/theVersion/theFiletype/theCreator/theSize/theCreation date/theModification date/theLabel  -- kind of first value to be found
  133.         first comparison  fIs/fIsNot/fContains/fContainsNot/fBeginsWith/fEndsWith/fMoreThan/fLessThan/fEarlierThan/fLaterThan  -- how to compare the value
  134.         first value  reference  -- find String, or filetype, or creator, or size or whatever
  135.         [operator  findAND/findOR]  -- if two find values: how to combine them
  136.         [second kind  theName/theComment/theVersion/theFiletype/theCreator/theSize/theCreation date/theModification date/theLabel]  -- kind of second value to be found
  137.         [second comparison  fIs/fIsNot/fContains/fContainsNot/fBeginsWith/fEndsWith/fMoreThan/fLessThan/fEarlierThan/fLaterThan]  -- how to compare the second value
  138.         [second value  reference]  -- find String, or filetype, or creator, or size or whatever
  139.         [add to found  boolean]  -- add the new results to the already found items, if any
  140.         [start find  boolean]  -- if true, then start find process immediately. If false, just set the values and activate the Find window.
  141.     [Result:   integer]  -- number of found items, or 0 if start find is false
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148. ===========================================================
  149. --  This is a short sample how to tell CDFinder to create catalog files of all local disks
  150. --  By Norbert M. Doerner 1999
  151.  
  152. tell application "Finder"
  153.     set volumeList to every disk as list
  154. end tell
  155.  
  156. tell application "CDFinder"
  157.     repeat with oneDisk in volumeList
  158.         set oneAlias to oneDisk as alias --  CDFinder needs an alias of the disk
  159.         with timeout of 500 seconds --  remember: this might take more than the default 60 seconds!
  160.             set myResult to create catalog of (oneAlias) --  use standard settings and do not update or duplicate
  161.         end timeout
  162.         if myResult = -128 then -- then the catalog might be already there
  163.         end if
  164.     end repeat
  165. end tell
  166.  
  167. --  PLEASE NOTE:
  168. --  If you have any ideas or suggestions or even better, code samples, please tell me!
  169.  
  170. --  Secret commands:
  171. --  By opening the preferences file, CDFinder will open the window to let you change the preferences.
  172. --  By opening any catalog file that is stored inside the catalog folder, CDFinder will open it
  173. --    and display its contents.
  174. --  These secret commands will go away once I figure out how to use properties and the 
  175. --   get/set data commands.